SureTax Returns API
GET Form Instance Change Log ID
Overview
This API endpoint retrieves the change log associated with a generated form instance. The change log provides a detailed record of any modifications made to the form instance, including information such as the type of change, timestamp, and the user responsible for the change. By accessing the change log, users can track the history of modifications made to the form instance, facilitating transparency and auditability of the data.
OperationId: GET Form Instance Change Log ID
Authorization Method(s): OAuth
Verb: GET
End Point: /api/v1/Forms/FormInstanceChangeLog
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Id* | Id | string |
Overview
Response object containing the change log for the form instance.
Example Response
The following is an example response you can expect for this operation
{
"data": {
"changeLog": [
{
"elementId": "12345",
"elementName": "Form Title",
"attributeId": "attr-001",
"attributeName": "Title",
"oldValue": "Old Form Title",
"newValue": "New Form Title",
"changedBy": "user123",
"changedOn": "2024-10-20T14:30:00Z"
}
]
}
}
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | The API response contains the change log for the specified form instance. Success Response - 200 OK. |
| 204 | 204 No Content If no records are found for the provided request, the API will respond with a No Content status. |
| 400 | Bad request. Invalid parameters or missing required information. |
| 401 | Unauthorized access. The request requires user authentication. |
| 500 | Internal server error. An error occurred while processing the request. |